IsMovieDone
Your application may wish to take a particular action when a movie is done playing. TheIsMovieDone
function allows you to determine if a particular movie has completely finished playing.
pascal Boolean IsMovieDone (Movie theMovie);
theMovie
- Specifies the movie for this operation. Your application obtains this movie identifier from such functions as
NewMovie
,NewMovieFromFile
, andNewMovieFromHandle
(described on page 2-80, page 2-76, and page 2-78, respectively).DESCRIPTION
TheIsMovieDone
function returnstrue
if the specified movie has finished playing; otherwise it returnsfalse
. A movie with a positive rate (playing forward) is considered done when its movie time reaches the movie end time. Conversely, a movie with a negative rate (playing backward) is considered done when its movie time reaches the movie start time.If your application has changed the movie's active segment, the status returned by the
IsMovieDone
function is relative to the active segment, rather than to the entire movie. You can use theSetMovieActiveSegment
function (described on page 2-121) to change a movie's active segment.ERROR CODES
invalidMovie -2010 This movie is corrupted or invalid